/*
 * The contents of this web application are subject to the Mozilla Public License Version 
 * 1.1 (the "License"); you may not use this web application except in compliance with 
 * the License. You may obtain a copy of the License at http://www.mozilla.org/MPL/.
 * 
 * Software distributed under the License is distributed on an "AS IS" basis, 
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License 
 * for the specific language governing rights and limitations under the License.
 * 
 * The Original Code is owned by and the Initial Developer of the Original Code is 
 * Composite A/S (Danish business reg.no. 21744409). All Rights Reserved
 * 
 * Section 11 of the License is EXPRESSLY amended to include a provision stating 
 * that any dispute, including but not limited to disputes related to the enforcement 
 * of the License, to which Composite A/S as owner of the Original Code, as Initial 
 * Developer or in any other role, becomes a part to shall be governed by Danish law 
 * and be initiated before the Copenhagen City Court ("K�benhavns Byret")            
 */

using System;


namespace Composite.Data
{
    /// <summary>
    /// Add this attribute to your data interface to control the physical store sort order of data.
    /// This concept is known as the clustered index on SQL Server.
    /// </summary>
    /// <example> This sample shows how to use the StoreSortOrder attribute.
    /// <code>
    /// [StoreSortOrderAttribute("Date", "Title")]
    /// // (other IData attributes)
    /// interface IMyDataType : IData
    /// {
    ///     // data type properties, must include Date and Title since we ref them above
    /// }
    /// </code>
    /// </example>    
    [AttributeUsage(AttributeTargets.Interface, AllowMultiple = false, Inherited = true)]
    public sealed class StoreSortOrderAttribute : Attribute
    {
        /// <summary>
        /// Sprcify the names of properties to order data by in the physical store. The specified names must exist as properties on your data type.
        /// </summary>
        /// <param name="sortOrder">Names of properties to order data by in the physical store.</param>
        public StoreSortOrderAttribute(params string[] sortOrder)
        {
            this.SortOrder = sortOrder;
        }


        /// <exclude />
        public string[] SortOrder
        {
            get;
            private set;
        }
    }
}
